#!/usr/bin/env python
###############################################################################
# Copyright (c) 2011-2013, Pacific Biosciences of California, Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
#   notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
# * Neither the name of Pacific Biosciences nor the names of its
#   contributors may be used to endorse or promote products derived from
#   this software without specific prior written permission.
#
# NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
# THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY PACIFIC BIOSCIENCES AND ITS
# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
# NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PACIFIC BIOSCIENCES OR
# ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
###############################################################################

"""This script defines a virtual class Service."""
from __future__ import absolute_import
from pbalign.utils.progutil import Availability, \
    CheckAvailability, Execute


class Service(object):
    """A Service object class."""
    @property
    def name(self):
        """Service name."""
        raise NotImplementedError(
            "Virtual property name() for {0} must be overwritten.".
            format(type(self)))

    @property
    def progName(self):
        """Program to call."""
        raise NotImplementedError(
            "Virtual property progName() for {0} must be overwritten.".
            format(type(self)))

    @property
    def availability(self):
        """Return True if self.progName is available, otherwise false."""
        return Availability(self.progName)

    @property
    def cmd(self):
        """Command to execute for this service."""
        raise NotImplementedError(
            "Virtual property progName() for {0} must be overwritten.".
            format(type(self)))

    def checkAvailability(self):
        """Raise a runtime error if program for this service is not
        available."""
        CheckAvailability(self.progName)

    def _execute(self):
        """Execute a command (self.cmd)."""
        return Execute(self.name, self.cmd)
